Skip to content

docs: self-serve gateway auth key rotation - #1172

Open
roh26it wants to merge 1 commit into
mainfrom
docs/gateway-auth-key-rotation
Open

roh26it wants to merge 1 commit into
mainfrom
docs/gateway-auth-key-rotation

Conversation

@roh26it

@roh26it roh26it commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds "Rotate the Gateway Authentication Key" to the Gateway Registration page (root and aigw/): open the deployment, Rotate Key, optional grace period (0 to 24 hours), copy the new key (shown once), update PORTKEY_CLIENT_AUTH, restart, verify.
  • Includes three cropped screenshots (rotate card, grace period dialog, one-time key).
  • Replaces "Contact support to have it reissued" in the credential rotation guide (root and aigw/) with the self-serve steps and a link to the new section. Recommends a short grace period when the key may be exposed.

For reviewers

  • The default grace period is not documented because the dialog doesn't state it. Please confirm and add it if it should be shown.
  • Not confirmed: availability and minimum gateway or backend version, and whether the aigw version keeps the PORTKEY_CLIENT_AUTH name (the aigw hybrid docs still use it).
  • The doc says to set the new key as PORTKEY_CLIENT_AUTH, based on the previous wording in the rotation guide.

🤖 Generated with Claude Code

Document Rotate Key on the Gateway Registration deployment page (grace period, one-time key) in the root and aigw pages, and replace the contact-support step in the credential rotation guide.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 12, 2026 17:41
@mintlify

mintlify Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
portkey-docs 🟢 Ready View Preview Nov 12, 2026, 5:43 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

Product/backend-owner confirmation is needed for rotation availability, minimum supported versions, the grace-period default, and Prisma AIRS credential support and mapping, which the docs-only snapshot cannot establish.

No open issues 🎉

What changed in this PR

Documents self-service gateway authentication key rotation for Portkey and Prisma AIRS, replacing the support-assisted process in both credential rotation guides.

Changes:

  • Adds rotation steps covering the optional 0–24-hour grace period, one-time key capture, PORTKEY_CLIENT_AUTH updates, gateway restarts, and connection verification.
  • Embeds screenshots of the rotation controls and warns about old-key expiration.
  • Links both credential rotation guides to the new instructions and recommends a short grace period for suspected exposure.
File Description
support/​rotate-credentials.mdx Replaces support-assisted rotation with self-service guidance and a section link.
self-hosting/​hybrid-deployments/​gateway-registration.mdx Adds the rotation procedure, screenshots, and grace-period warning.
aigw/​support/​rotate-credentials.mdx Mirrors the updated credential rotation guidance for Prisma AIRS.
aigw/​self-hosting/​hybrid-deployments/​gateway-registration.mdx Adds the equivalent Prisma AIRS rotation procedure and warnings.

Review effort: Balanced

This branch was successfully deployed

1 active deployment
staging — ecca7aa3 Deployed Nov 12, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants